Extension point codecs

In component org.nuxeo.ecm.platform.url.service.DocumentViewCodecService

Documentation

Codecs perform the translation between a url and a document view that holds information about the document context as well as other parameters (current tab for instance).

Contribution Descriptors

Class: org.nuxeo.ecm.platform.url.codec.descriptor.DocumentViewCodecDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathadmin" prefix="nxadmin"/>

  </extension>

(0) nuxeo-admin-center-jsf-2023.22.13.jar/OSGI-INF/urlservice-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentViewCodec class="org.nuxeo.ui.web.url.codec.JSFNotificationDocumentIdCodec" enabled="true" name="notificationDocId" prefix="nxdoc" priority="10"/>
  </extension>

(1) nuxeo-platform-ui-web-2023.22.13.jar/OSGI-INF/url-codecs-jsf-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

    <documentation>Declare codec for nxrendition urls</documentation>

    <documentViewCodec class="org.nuxeo.ecm.platform.rendition.url.DocumentRenditionCodec" enabled="true" name="rendition" prefix="nxrendition"/>
  </extension>

(2) nuxeo-platform-rendition-web-2023.22.13.jar/OSGI-INF/url-codec-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="downloadPicture" prefix="nxpicsfile"/>
  </extension>

(3) nuxeo-platform-imaging-jsf-2023.22.13.jar/OSGI-INF/imaging-codec-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentation>
      The docid codec uses the document uid to resolve the context. Urls are of
      the form http://site/nuxeo/nxdoc/demo/docuid/view.

      The docpath codec uses the document path to resolve the context. Urls are
      of the form http://site/nuxeo/nxpath/demo/path/to/my/doc@view.

      The document file codec uses the document uid to resolve the document
      model and extract a file held in its properties. Urls are of the form
      http://site/nuxeo/nxfile/demo/docuid/file:content/mydoc.odt.

      We declare three codecs using this same class but different prefixes
      (nxfile, nxeditfile,...) so that we can define several url patterns,
      performing different actions, but still using the same syntax.
    </documentation>
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentIdCodec" default="true" enabled="true" name="docid" prefix="nxdoc"/>
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpath" prefix="nxpath"/>
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="editFile" prefix="nxeditfile"/>
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="pdfFile" prefix="nxpdffile"/>
  </extension>

(4) nuxeo-platform-url-2023.22.13.jar/OSGI-INF/docviewurlservice-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="downloadThumbnail" prefix="nxthumb"/>
  </extension>

(5) nuxeo-platform-webapp-base-2023.22.13.jar/OSGI-INF/thumbnail-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

      <documentViewCodec class="org.nuxeo.ecm.platform.preview.codec.DocumentPreviewCodec" enabled="true" name="preview" prefix="restAPI/preview"/>
    </extension>

(6) nuxeo-preview-jsf-2023.22.13.jar/OSGI-INF/docview-codec-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentViewCodec class="org.nuxeo.ecm.restapi.server.jaxrs.RestDocumentViewCodec" default="false" enabled="true" name="restdocid"/>
  </extension>

(7) nuxeo-rest-api-server-2023.22.13.jar/OSGI-INF/docviewurl-service-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathworkflow" prefix="nxworkflow"/>

  </extension>

(8) nuxeo-routing-dashboard-2023.22.13.jar/OSGI-INF/document-routing-dashboard-urlservice-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

    <documentViewCodec class="org.nuxeo.search.ui.codec.SearchCodec" default="false" enabled="true" name="docpathsearch" prefix="nxsearch"/>

  </extension>

(9) nuxeo-search-ui-2023.22.13.jar/OSGI-INF/search-url-service-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">

    <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathhome" prefix="nxhome"/>

    <documentation>
      The user codec uses the given username to select and display a user.
      Urls are of the form http://site/nuxeo/user/username(/view).

      The view is optional, and defaults to view_home if not present.
    </documentation>
    <documentViewCodec class="org.nuxeo.ecm.user.center.UserCodec" default="false" enabled="true" name="user" prefix="user"/>
    <documentViewCodec class="org.nuxeo.ecm.user.center.GroupCodec" default="false" enabled="true" name="group" prefix="group"/>

  </extension>

(10) nuxeo-user-center-2023.22.13.jar/OSGI-INF/urlservice-contrib.xml Override

<extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    <documentViewCodec class="org.nuxeo.web.ui.url.codec.WebNotificationDocumentIdCodec" enabled="true" name="notificationDocId" prefix="doc" priority="100"/>
  </extension>

(11) nuxeo-web-ui-3.1.13.jar/OSGI-INF/url-codecs-web-contrib.xml Override